package infoholders;

/**
 * Treatment.java
 */
import java.io.File;

/**
 * This is the treatment class. It doesn't do very much, it just represents a
 * treatment.
 * 
 * @author Henry Smith
 * @version 1.0
 * 
 */
public class Treatment {

	/**
	 * Type enum used to keep track of which type of treatment this represents.
	 */
	public enum Type {

		/** The Office Visit. */
		OFFICEVISIT,
		/** The Phone Consult. */
		PHONECONSULT,
		/** The Annual Physical */
		ANNUALPHYSICAL
	};

	/** The type of the treatment being represented. */
	private Type treatmentType;

	/** Additional details or other information. */
	private String treatmentDetails;

	/**
	 * This is the constructor with one parameter, and just sets the type.
	 * 
	 * @param treatmentType
	 *            the type of treatment.
	 */
	public Treatment(Type treatmentType) {
		this.setTreatmentType(treatmentType);
	}

	/**
	 * getter for treatmentDetails
	 * 
	 * @return File the treatmentDetails for this treatment
	 */
	public String getTreatmentDetails() {
		return treatmentDetails;
	}

	/**
	 * @return String representation of this treatment
	 */
	public String toString() {
		return "Treatment";
	}

	/**
	 * setter for treatmentDetails
	 * 
	 * @param treatmentDetails
	 *            the new treatmentDetails file,<br/>
	 *            which is assumed to be the correct type.
	 */
	public void setTreatmentDetails(String treatmentDetails) {
		this.treatmentDetails = treatmentDetails;
	}

	/**
	 * Sets the type of the treatment being represented.
	 * 
	 * @param treatmentType
	 *            the new type of the treatment being represented
	 */
	public void setTreatmentType(Type treatmentType) {
		this.treatmentType = treatmentType;
	}

	/**
	 * Gets the type of the treatment being represented.
	 * 
	 * @return the type of the treatment being represented
	 */
	public Type getTreatmentType() {
		return treatmentType;
	}
}
